cloud: audit log CLI #21786
cloud: audit log CLI #21786
Conversation
ti-chi-bot
bot
added
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @shiyuhang0, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly expands and refactors the command-line interface documentation for managing audit logs within TiDB Cloud Essential clusters. It introduces a suite of new commands for granular control over audit log configuration, including cloud storage integration and rotation policies, as well as comprehensive management of audit log filter rules. The changes aim to provide users with a more robust and intuitive CLI experience for audit log operations.
Highlights
- New Audit Log CLI Commands: Introduced a comprehensive set of new CLI commands for managing audit logs, including
config update,config describe,filter-rule create,filter-rule delete,filter-rule describe,filter-rule list,filter-rule template, anddownload. - Refactored Audit Log Documentation: Existing documentation for
ticloud serverless audit-log configandticloud serverless audit-log downloadhas been replaced with more detailed and structured versions, enhancing clarity and completeness. - Standardized Command Naming: All audit log CLI commands now adhere to a consistent
ticloud serverless audit-log <sub-command> <action>structure, improving discoverability and ease of use. - Enhanced Audit Log Configuration: New options for configuring audit logs are available, including integration with various cloud storage providers (S3, GCS, Azure Blob, OSS) and advanced rotation strategies.
- Improved Filter Rule Management: Dedicated commands have been added for granular management of audit log filter rules, allowing users to create, delete, describe, list, update, and view templates for these rules.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for the ticloud CLI, specifically for the audit-log subcommands, to reflect a restructuring of the commands. The changes involve renaming files, creating new ones, and modifying content to match the new command structure. Overall, the updates are good, but I've found several inconsistencies in wording, formatting issues such as using quotes instead of backticks for commands, and some unclear descriptions. I have provided specific suggestions to improve clarity and ensure adherence to the style guide.
hfxsd
added
translation/no-need
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
tidb-cloud/ticloud-serverless-audit-log-filter-rule-template.md
Outdated
Show resolved
Hide resolved
tidb-cloud/ticloud-serverless-audit-log-filter-rule-template.md
Outdated
Show resolved
Hide resolved
Co-authored-by: xixirangrang <[email protected]>
|
@zhangyangyu: adding LGTM is restricted to approvers and reviewers in OWNERS files. In response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
tidb-cloud/ticloud-serverless-audit-log-filter-rule-describe.md
Outdated
Show resolved
Hide resolved
tidb-cloud/ticloud-serverless-audit-log-filter-rule-template.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Aolin <[email protected]>
Co-authored-by: Aolin <[email protected]>
ti-chi-bot
bot
added
lgtm
and removed
needs-1-more-lgtm
|
/retest |
|
/approve |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hfxsd The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
5 participants
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?